Salesforce UX API
TMF-671 GET Coupons detail from Aria
This API provides detailed information including discount rules, and discount bundles for coupons that are assigned to an account (BAN-CAN) or a master plan instance.
URL
https://[localhost]:[port]/sfdc-ux/v1/{businessId}/promotionurl Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR" for LCPR integration | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - This should be unique-id for each transaction | Y |
Query Param
| name | type | description | required |
|---|---|---|---|
| pattern.characteristic.name | string | Name of the characteristic. Below are the expected values: "BAN-CAN" & "AMPI" Eg: pattern.characteristic.name=BAN-CAN,AMPI | Y |
| pattern.characteristic.value | string | Value of the characteristic In this case, the value of "BAN-CAN (client_acct_id) & AMPI (client_master_plan_instance_id)" Eg: pattern.characteristic.value=23532448-23533064,23532448-23533064 | Y |
| promotionType | string | Type of promotion. Note - The expected value is "coupons" to work this functionality | Y |
cULR
curl --location 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/v1/PR/promotion?pattern.characteristic.name=BAN-CAN,AMPI&pattern.characteristic.value=23532448-23533064,23532448-23533064&promotionType=coupons' \
--header 'client_id: abcd' \
--header 'client_secret: 12345' \
--header 'X-Correlation-Id: 644e1dd7-2a7f-18fb-b8ed-124356'Response
In this section all the possible data structures received by the client at the moment of responding the method are defined.
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ]
OK - Get request processed successfully, response body contains an entity corresponding to the requested resource.
[
{
"pattern": [
{
"id": "autopay_discount_cc_5",
"description": "AutoPay / eBill discount|Descuento por Autopago y Factura Electrónica",
"validFor": {
"startDateTime": "2025-01-07T14:32:45"
},
"characteristic": [
{
"name": "BAN-CAN",
"value": "23532448-23533064"
},
{
"name": "out_client_master_plan_instance_id",
"value": "23532448-23533064"
},
{
"name": "out_acct_no",
"value": 44384571
},
{
"name": "out_master_plan_instance_no",
"value": 68305680
},
{
"name": "coupon_scope",
"value": "1"
},
{
"name": "total_uses",
"value": "0"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "recur_discount_flat_amt",
"value": "0"
},
{
"name": "one_time_discount_flat_amt",
"value": "0"
},
{
"name": "recur_discount_pct",
"value": "0"
},
{
"name": "one_time_discount_pct",
"value": "0"
},
{
"name": "status_ind",
"value": "1"
},
{
"name": "group_no",
"value": "362"
},
{
"name": "client_group_id",
"value": "autopay_discount_cc_5"
},
{
"name": "group_name",
"value": "autopay_discount_cc_5"
},
{
"name": "group_description",
"value": "AutoPay / eBill discount|Descuento por Autopago y Factura Electrónica"
},
{
"name": "group_precedence",
"value": 13
},
{
"name": "coupon_assignment_no",
"value": 835767
},
{
"name": "coupon_message",
"value": "AutoPay / eBill discount|Descuento por Autopago y Factura Electrónica"
},
{
"name": "coupon_assignment_date",
"value": "2025-01-07 14:32:45"
}
],
"action": [
{
"id": "autopay_discount_5_PR_B2C_4GB_Plan_MB_Line",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Auto Pay Discount 5 PR_B2C_4GB_Plan_MB_Line"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Auto Pay Discount 5 PR_B2C_4GB_Plan_MB_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104083",
"name": "Auto Pay Discount 5 PR_B2C_4GB_Plan_MB_Line"
},
"@type": "DiscountRule"
},
{
"id": "autopay_discount_5_PR_B2C_ULT_50_Plus_MB_Line",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Auto Pay Discount 5 PR_B2C_4GB_Plan_MB_Line"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Auto Pay Discount 5 PR_B2C_4GB_Plan_MB_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104083",
"name": "Auto Pay Discount 5 PR_B2C_4GB_Plan_MB_Line"
},
"@type": "DiscountRule"
},
{
"id": "autopay_discount_5_PR_B2C_ULT_Value_Plus_MB_Line",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Auto Pay Discount 5 PR_B2C_ULT_Value_Plus_MB_Line"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Auto Pay Discount 5 PR_B2C_ULT_Value_Plus_MB_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104085",
"name": "Auto Pay Discount 5 PR_B2C_ULT_Value_Plus_MB_Line"
},
"@type": "DiscountRule"
},
{
"id": "autopay_discount_5_PR_B2C_Value_Plus_2GB_MB_Line",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Auto Pay Discount 5 PR_B2C_Value_Plus_2GB_MB_Line"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Auto Pay Discount 5 PR_B2C_Value_Plus_2GB_MB_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104086",
"name": "Auto Pay Discount 5 PR_B2C_Value_Plus_2GB_MB_Line"
},
"@type": "DiscountRule"
},
{
"id": "autopay_discount_5_PR_B2C_ULT_Starter_MB_Line",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Auto Pay Discount 5 PR_B2C_ULT_Starter_MB_Line"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Auto Pay Discount 5 PR_B2C_ULT_Starter_MB_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104087",
"name": "Auto Pay Discount 5 PR_B2C_ULT_Starter_MB_Line"
},
"@type": "DiscountRule"
},
{
"id": "autopay_discount_5_PR_B2C_ULT_Extra_MB_Line",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Auto Pay Discount 5 PR_B2C_ULT_Extra_MB_Line"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Auto Pay Discount 5 PR_B2C_ULT_Extra_MB_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104088",
"name": "Auto Pay Discount 5 PR_B2C_ULT_Extra_MB_Line"
},
"@type": "DiscountRule"
},
{
"id": "autopay_discount_5_PR_B2C_ULT_Premium_MB_Line",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Auto Pay Discount 5 PR_B2C_ULT_Premium_MB_Line"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Auto Pay Discount 5 PR_B2C_ULT_Premium_MB_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104089",
"name": "Auto Pay Discount 5 PR_B2C_ULT_Premium_MB_Line"
},
"@type": "DiscountRule"
},
{
"id": "autopay_discount_5_PR_B2C_ULT_Elite_MB_Line",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Auto Pay Discount 5 PR_B2C_ULT_Elite_MB_Line"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Auto Pay Discount 5 PR_B2C_ULT_Premium_MB_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104090",
"name": "Auto Pay Discount 5 PR_B2C_ULT_Elite_MB_Line"
},
"@type": "DiscountRule"
},
{
"id": "autopay_discount_5_PR_B2C_Conn_tablet_Line",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Auto Pay Discount 5 PR_B2C_Conn_tablet_Line"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Auto Pay Discount 5 PR_B2C_Conn_tablet_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104091",
"name": "Auto Pay Discount 5 PR_B2C_Conn_tablet_Line"
},
"@type": "DiscountRule"
},
{
"id": "autopay_discount_5_PR_B2C_MiFi_Line",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Auto Pay Discount 5 PR_B2C_MiFi_Line"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Auto Pay Discount 5 PR_B2C_MiFi_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104092",
"name": "Auto Pay Discount 5 PR_B2C_MiFi_Line"
},
"@type": "DiscountRule"
},
{
"id": "autopay_discount_5_PR_B2C_100GB_MiFi_Line",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Auto Pay Discount 5 PR_B2C_100GB_MiFi_Line"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Auto Pay Discount 5 PR_B2C_100GB_MiFi_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104093",
"name": "Auto Pay Discount 5 PR_B2C_100GB_MiFi_Line"
},
"@type": "DiscountRule"
},
{
"id": "autopay_discount_5_PR_B2C_Connected_Laptop_Line",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Auto Pay Discount 5 PR_B2C_Connected_Laptop_Line"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Auto Pay Discount 5 PR_B2C_Connected_Laptop_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104094",
"name": "Auto Pay Discount 5 PR_B2C_Connected_Laptop_Line"
},
"@type": "DiscountRule"
},
{
"id": "autopay_discount_5_PR_B2C_200GB_MiFi_Line",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "AutoPay Discount PR_B2C_200GB_MiFi_Line"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "AutoPay Discount PR_B2C_200GB_MiFi_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104095",
"name": "AutoPay Discount PR_B2C_200GB_MiFi_Line"
},
"@type": "DiscountRule"
},
{
"id": "autopay_discount_5_PR_B2C_FWA_5G_4G_USVI_LINE",
"actionType": "currency",
"actionValue": "5",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "AutoPay Discount PR_B2C_FWA_5G_4G_USVI_LINE"
},
{
"name": "flat_percent_ind",
"value": "F"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "AutoPay Discount PR_B2C_FWA_5G_4G_USVI_LINE"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "104111",
"name": "AutoPay Discount 5 PR_B2C_FWA_5G_4G_"
},
"@type": "DiscountRule"
}
]
},
{
"id": "apprdiscount_25pct",
"description": "Appreciation Discount|Descuento de Apreciación",
"validFor": {
"startDateTime": "2025-01-07T14:32:45"
},
"extendedCharacteristic": [
{
"name": "BAN-CAN",
"value": "23532448-23533064"
},
{
"name": "out_acct_no",
"value": 44384571
},
{
"name": "out_client_master_plan_instance_id",
"value": "23532448-23533064"
},
{
"name": "out_master_plan_instance_no",
"value": 68305680
},
{
"name": "coupon_scope",
"value": "1"
},
{
"name": "total_uses",
"value": "0"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "recur_discount_flat_amt",
"value": "0"
},
{
"name": "one_time_discount_flat_amt",
"value": "0"
},
{
"name": "recur_discount_pct",
"value": "0"
},
{
"name": "one_time_discount_pct",
"value": "0"
},
{
"name": "status_ind",
"value": "1"
},
{
"name": "group_no",
"value": "362"
},
{
"name": "client_group_id",
"value": "apprdiscount_25pct"
},
{
"name": "group_name",
"value": "apprdiscount_25pct"
},
{
"name": "group_description",
"value": "Appreciation Discount|Descuento de Apreciación"
},
{
"name": "group_precedence",
"value": 15
},
{
"name": "coupon_assignment_no",
"value": 835766
},
{
"name": "coupon_message",
"value": "Appreciation Discount|Descuento de Apreciación"
},
{
"name": "coupon_assignment_date",
"value": "2025-01-07T14:32:45"
}
],
"action": [
{
"id": "Appreciation_Discount_PR_B2C_Liberty_Connected_Wearable",
"actionType": "currency",
"actionValue": "25",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Appreciation Discount PR_B2C_Liberty_Connected_Wearable"
},
{
"name": "flat_percent_ind",
"value": "P"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Appreciation Discount PR_B2C_Liberty_Connected_Wearable"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "91910",
"name": "Appreciation Discount PR_B2C_Liberty_Connected_Wearable"
},
"@type": "DiscountRule"
},
{
"id": "Appreciation_Discount_PR_B2C_ULT_Starter_MB_Line",
"actionType": "currency",
"actionValue": "25",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Appreciation Discount PR_B2C_ULT_Starter_MB_Line"
},
{
"name": "flat_percent_ind",
"value": "P"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Appreciation Discount PR_B2C_ULT_Starter_MB_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "91913",
"name": "Appreciation Discount PR_B2C_ULT_Starter_MB_Line"
},
"@type": "DiscountRule"
},
{
"id": "Appreciation_Discount_PR_B2C_ULT_Extra_MB_Line",
"actionType": "currency",
"actionValue": "25",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Appreciation Discount PR_B2C_ULT_Extra_MB_Line"
},
{
"name": "flat_percent_ind",
"value": "P"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Appreciation Discount PR_B2C_ULT_Extra_MB_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "91914",
"name": "Appreciation Discount PR_B2C_ULT_Extra_MB_Line"
},
"@type": "DiscountRule"
},
{
"id": "Appreciation_Discount_PR_B2C_ULT_Premium_MB_Line",
"actionType": "currency",
"actionValue": "25",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Appreciation Discount PR_B2C_ULT_Premium_MB_Line"
},
{
"name": "flat_percent_ind",
"value": "P"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Appreciation Discount PR_B2C_ULT_Premium_MB_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "91915",
"name": "Appreciation Discount PR_B2C_ULT_Premium_MB_Line"
},
"@type": "DiscountRule"
},
{
"id": "Appreciation_Discount_PR_B2C_ULT_Elite_MB_Line",
"actionType": "currency",
"actionValue": "25",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Appreciation Discount PR_B2C_ULT_Elite_MB_Line"
},
{
"name": "flat_percent_ind",
"value": "P"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Appreciation Discount PR_B2C_ULT_Elite_MB_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "91916",
"name": "Appreciation Discount PR_B2C_ULT_Elite_MB_Line"
},
"@type": "DiscountRule"
},
{
"id": "Appreciation_Discount_PR_B2C_Standalone_UNL_Tablet_Line",
"actionType": "currency",
"actionValue": "25",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Appreciation Discount PR_B2C_Standalone_UNL_Tablet_Line"
},
{
"name": "flat_percent_ind",
"value": "P"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Appreciation Discount PR_B2C_Standalone_UNL_Tablet_Line"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "93859",
"name": "Appreciation Discount PR_B2C_Standalone_UNL_Tablet_Line"
},
"@type": "DiscountRule"
},
{
"id": "Appreciation_Discount_PR_B2C_ATT_Unlimited_Beyond_Premium",
"actionType": "currency",
"actionValue": "25",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Appreciation Discount PR_B2C_ATT_Unlimited_Beyond_Premium"
},
{
"name": "flat_percent_ind",
"value": "P"
},
{
"name": "currency_cd",
"value": "GBP"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Appreciation Discount PR_B2C_ATT_Unlimited_Beyond_Premium"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "98485",
"name": "Appreciation Discount PR_B2C_ATT_Unlimited_Beyond_Premium"
},
"@type": "DiscountRule"
},
{
"id": "Appreciation_Discount_PR_B2C_ATT_Unlimited_Beyond",
"actionType": "currency",
"actionValue": "25",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Appreciation Discount PR_B2C_ATT_Unlimited_Beyond"
},
{
"name": "flat_percent_ind",
"value": "P"
},
{
"name": "currency_cd",
"value": "GBP"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Appreciation Discount PR_B2C_ATT_Unlimited_Beyond"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "98486",
"name": "Appreciation Discount PR_B2C_ATT_Unlimited_Beyond"
},
"@type": "DiscountRule"
},
{
"id": "Appreciation_Discount_PR_B2C_FWA_5G_4G_USVI_LINE",
"actionType": "currency",
"actionValue": "25",
"characteristic": [
{
"name": "scope_no",
"value": 13
},
{
"name": "description",
"value": "Appreciation Discount PR_B2C_FWA_5G_4G_USVI_LINE"
},
{
"name": "flat_percent_ind",
"value": "P"
},
{
"name": "currency_cd",
"value": "USD"
},
{
"name": "inline_offset_ind",
"value": "O"
},
{
"name": "duration_type_ind",
"value": "I"
},
{
"name": "remainder_discount_rule_indicator",
"value": 0
},
{
"name": "ext_description",
"value": "Appreciation Discount PR_B2C_FWA_5G_4G_USVI_LINE"
},
{
"name": "scope_overridden",
"value": "N"
},
{
"name": "scope_label",
"value": "Specified Plan/Service Charges"
}
],
"actionEntityRef": {
"id": "103493",
"name": "Appreciation Discount PR_B2C_FWA_5G_4G_USVI_LINE"
},
"@type": "DiscountRule"
}
]
}
]
}
]Definitions
| name | type | description | required |
|---|---|---|---|
| pattern | array | A list of coupons detail | N |
| pattern.id | string | The unique coupon ID | N |
| pattern.description | string | A long description of the coupon | N |
| pattern.validFor | object | A time period. | N |
| pattern.validFor.startDateTime | datetime | Specifies the coupon effective date | N |
| pattern.characteristic | array | Pattern characteristic, for more info please refer below 'pattern.characteristic' table | N |
| pattern.characteristic.name | string | Name of the characteristic | N |
| pattern.characteristic.value | any | The value of the characteristic | N |
| pattern.action | array | Discount Rules | N |
| pattern.action.id | string | Client-defined name or ID for this discount rule | N |
| pattern.action.actionType | string | Action type. Eg: currency | N |
| pattern.action.actionValue | string | The amount of discount, which is either a flat amount or a percentage, based on the value of flat_percent_ind | N |
| pattern.action.characteristic | array | Pattern action characteristic, for more info please refer below 'pattern.action.characteristic' table | N |
| pattern.action.characteristic.name | string | Name of the characteristic | N |
| pattern.action.characteristic.value | any | The value of the characteristic | N |
| pattern.action.actionEntityRef | object | An entity reference | N |
| pattern.action.actionEntityRef.id | string | The unique ID of this discount rule | N |
| pattern.action.actionEntityRef.name | string | The name of this discount rule | N |
| pattern.action.@type | string | Type of the Rule | N |
pattern.characteristic values
| characteristic name | type | description | required |
|---|---|---|---|
| BAN-CAN | string | This is the client-assigned identifier for the account. | N |
| out_client_master_plan_instance_id | string | Client defined Account Master Plan Instance Id | N |
| out_acct_no | integer | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. If passed, only the coupons assigned to this account will be returned. | N |
| out_master_plan_instance_no | integer | Aria defined Master Subscription plan instance number. | N |
| coupon_scope | string | Specifies the coupon application. Allowable Values are 0 - Account 1 - Master Plan Instance 2 - Account and Master Plan Instance | N |
| total_uses | string | The number of times this coupon has been used | N |
| currency_cd | string | The currency code to which this discount rule applies | N |
| recur_discount_flat_amt | string | A recurring discount amount expressed as a flat currency amount discount | N |
| one_time_discount_flat_amt | string | A one-time discount amount expressed as a flat currency amount discount | N |
| recur_discount_pct | string | A recurring discount amount expressed as a percentage of the charges | N |
| one_time_discount_pct | string | A one-time discount amount expressed as a percentage of the charges | N |
| status_ind | string | Whether or not the coupon is active | N |
| group_no | string | Aria-assigned group number | N |
| client_group_id | string | Specifies Client-defined ID for coupon group | N |
| group_name | string | Specified coupon group name | N |
| group_description | string | Specifies group description | N |
| group_precedence | integer | Specifies the precedence of the coupon group | N |
| coupon_assignment_no | integer | Specifies the coupon assignment ID | N |
| coupon_message | string | Coupon message defined at the catalog level that can be subsequently displayed to end users upon successful application of this coupon to their account or to a master plan instance | N |
| coupon_assignment_date | datetime | Specifies the coupon assignment date | N |
pattern.action.characteristic values
| characteristic name | type | description | required |
|---|---|---|---|
| scope_no | integer | The applicability of this discount rule | N |
| description | string | The long description of this discount rule | N |
| flat_percent_ind | string | Whether or not this is a flat discount or a percentage based one | N |
| currency_cd | string | The currency code to which this discount rule applies | N |
| inline_offset_ind | string | Whether or not this discount is applied inline or as its own line | N |
| duration_type_ind | string | Indicates whether this discount rule expires after a specific duration, or after a number of uses | N |
| remainder_discount_rule_indicator | integer | When set as TRUE (1), it will prorate the discount applied on the initial invoice and apply the remaining proportion of the discount on the appropriate invoice. By default it's null. This parameter is only applicable when someone enters max_applicable_months. It will be null if no input is given else will be stored as 1 or 0 on what user enters. | N |
| ext_description | string | A user-friendly public facing description | N |
| scope_overridden | string | Specifies Y/N if coupon scope is overridden | N |
| scope_label | string | Charges eligible to receive the discount | N |
Possible response error
In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.
[ 400 ]
Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
{
"errors": [{
"code": 400,
"message": "Aria : Error While Fetching coupons",
"description": "Invalid Account Number for BusinessID : PR"
}]
}[ 401 ]
Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.
{
"errors" : [{
"code" : 401,
"message" : "The user could not be authenticated for this request.",
"description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
}]
}[ 403 ]
Forbidden - Indicates that the server understood the request but refuses to fulfill it. If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials.
[ 404 ]
Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.
{
"errors" : [{
"code" : 404,
"message" : "The request is invalid or not properly formed.",
"description" : "The requested operation failed because a resource associated with the request could not be found."
}]
}[ 405 ]
Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
{
"errors": [{
"code": 405,
"message": "APIKIT:METHOD_NOT_ALLOWED",
"description": "HTTP Method post not allowed for : /{businessId}/promotion"
}]
}[ 500 ]
Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.
{
"errors" : [{
"code" : 500,
"message" : "The request failed due to an internal error.",
"description": ""
}]
}[ 501 ]
Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.
{
"errors" : [{
"code" : 501,
"message" : "Not implemented",
"description" : "Operation GET /promotion for Business Id: xxxx not implemented"
}]
}